- Print
- DarkLight
Callouts are used to draw attention to specific information or to provide additional context or explanations for a particular concept or procedure. Callouts are often used to highlight important points, provide examples, or give cautionary notes or warnings.
There are several different types of callouts that can be used in technical documentation, including notes, tips, warnings, errors, and examples.
Notes: Notes are used to provide additional information or context on a particular topic. They may be used to explain a concept in more detail or to provide guidance on how to apply the information to a specific situation.
Tips: Tips are used to provide helpful hints or suggestions that may make a task easier or more efficient. They may be used to provide best practices or recommend specific tools or techniques.
Warnings: Warnings are used to alert readers to potential hazards or risks associated with a particular procedure or task. They may be used to caution readers about potential risks or to provide instructions on how to avoid them.
Errors: Errors are used to indicate problems or issues that may arise when using a product or system. They may be used to alert readers to issues that could cause the system to malfunction or to provide instructions on how to troubleshoot or fix the problem
Examples: Examples are used to illustrate a concept or procedure with a specific example. They may be used to show how a particular code snippet works or to demonstrate how to use a particular tool or feature.